docs: Add some information about event axes
authorMatthias Clasen <mclasen@redhat.com>
Wed, 15 Dec 2021 22:29:32 +0000 (17:29 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 16 Dec 2021 02:58:57 +0000 (21:58 -0500)
gdk/gdkevents.c

index 5ce7724eb4142a33c4f27336fe8b39281d8e3b05..71774ae50ec75e21650580d46213e9fa73e4e6dd 100644 (file)
@@ -942,6 +942,9 @@ gdk_event_get_pointer_emulated (GdkEvent *event)
  * Extract the axis value for a particular axis use from
  * an event structure.
  *
+ * To find out which axes are used, use [method@Gdk.DeviceTool.get_axes]
+ * on the device tool returned by [method@Gdk.Event.get_device_tool].
+ *
  * Returns: %TRUE if the specified axis was found, otherwise %FALSE
  */
 gboolean
@@ -1168,6 +1171,9 @@ G_DEFINE_BOXED_TYPE (GdkEventSequence, gdk_event_sequence,
  *
  * Extracts all axis values from an event.
  *
+ * To find out which axes are used, use [method@Gdk.DeviceTool.get_axes]
+ * on the device tool returned by [method@Gdk.Event.get_device_tool].
+ *
  * Returns: %TRUE on success, otherwise %FALSE
  */
 gboolean